3.2 Consultar responsáveis financeiros

Request

Request

query FinancialOwners {
    financialOwners(skip: 0, take: 1) {
        items {
            refId
            name
            cpf
            email
            companyId
            id
            creationDate
            active
            deleted
            address {
                city
                state
                country
                district
                street
                zipCode
                number
                complement
            }
            dependents {
                refId
                name
                cpf
                email
            }
        }
        pageInfo {
            hasNextPage
            hasPreviousPage
        }
        totalCount
    }
}

Params

Parâmetro	Tipo	Descrição
skip	Int	Número de registros a serem pulados no início da coleção. Utilizado para paginação.
take	Int	Número máximo de registros a serem retornados. Utilizado para paginação.
where	FinancialOwnerFilterInput	Objeto que define os critérios de filtragem para os planos de pagamento.
order	[FinancialOwnerSortInput!]	Array de objetos que definem a ordem de classificação dos resultados.

Objeto FinancialOwnerFilterInput

Campo	Tipo	Descrição
active	BooleanOperationFilterInput	Status de Ativação
address	AddressFilterInput	Dados do Endereço
and	[FinancialOwnerFilterInput!]	Combinação de filtros AND
apiRequestLogs	ListFilterInputTypeOfApiRequestLogFilterInput	Logs de requisições API
billings	ListFilterInputTypeOfBillingFilterInput	Dados das Cobranças
changes	ListFilterInputTypeOfLogHistoryFilterInput	Histórico de alterações
company	CompanyFilterInput	Dados da Empresa
companyId	IntOperationFilterInput	Id da Empresa
cpf	StringOperationFilterInput	CPF
creationDate	DateTimeOperationFilterInput	Data de Criação
customFields	ListFilterInputTypeOfCustomFieldContentFilterInput	Dados dos Campos Customizáveis
deleted	BooleanOperationFilterInput	Status de Deleção
dependents	ListFilterInputTypeOfDependentFilterInput	Dados dos Dependentes
documents	ListFilterInputTypeOfFinancialOwnerDocumentFileFilterInput	Documentos do responsável financeiro
email	StringOperationFilterInput	Email
externalId	IntOperationFilterInput	Id Externo
graphQLRequestLogs	ListFilterInputTypeOfGraphQLRequestLogFilterInput	Logs de requisições GraphQL
id	IntOperationFilterInput	Id do objeto da Requisição
lastUpdateDate	DateTimeOperationFilterInput	Data da última atualização
name	StringOperationFilterInput	Nome
or	[FinancialOwnerFilterInput!]	Combinação de filtros OR
paymentPlans	ListFilterInputTypeOfPaymentPlanFilterInput	Dados dos Planos de Pagamento
refId	UuidOperationFilterInput	Id da Referência

Objeto FinancialOwnerSortInput

Campo	Tipo de Ordenação	Descrição
active	SortEnumType	Status de Ativação
address	AddressSortInput	Dados do Endereço
company	CompanySortInput	Dados da Empresa
companyId	SortEnumType	Identificador da Empresa
cpf	SortEnumType	Número de CPF
creationDate	SortEnumType	Data de Criação
deleted	SortEnumType	Status de Deleção
email	SortEnumType	Endereço de Email
externalId	SortEnumType	Identificador Externo
id	SortEnumType	Identificador Único
lastUpdateDate	SortEnumType	Data da Última Atualização
name	SortEnumType	Nome
refId	SortEnumType	Identificador de Referência

Response

Response

{
  "data": {
    "financialOwners": {
      "items": [
        {
          "refId": "c778a908-1190-414b-887d-f0b5571e4f11",
          "name": "RESPONSAVEL AADRIANA TESTE REMATRICULA",
          "cpf": "73387346310",
          "email": "boletosedux@gmail.com",
          "companyId": 1,
          "id": 46,
          "creationDate": "2023-10-06T19:14:22.267Z",
          "active": true,
          "deleted": false,
          "address": {
            "city": "Volta Redonda",
            "state": "RJ",
            "country": null,
            "district": "Jardim das Flores",
            "street": "RUA 1",
            "zipCode": "27250000",
            "number": "11",
            "complement": null
          },
          "dependents": [
            {
              "refId": "4e245642-87f9-42df-948f-e54bbda1ee67",
              "name": "1 - ADRIANA TESTE REMATRICULA",
              "cpf": null,
              "email": ""
            }
          ]
        }
      ],
      "pageInfo": {
        "hasNextPage": true,
        "hasPreviousPage": false
      },
      "totalCount": 7
    }
  }
}

Result

Campo	Tipo	Descrição
financialOwners	FinancialOwnersCollectionSegment	Coleção de responsáveis financeiros

Objeto FinancialOwnersColletionSegment

Campo	Tipo	Descrição
items	[FinancialOwner!]	Lista de objetos do tipo "FinancialOwner".
pageInfo	CollectionSegmentInfo!	Informações para auxiliar na paginação dos resultados.
totalCount	Int!	Número total de registros encontrados, independentemente da paginação.